<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- qpaintengine.cpp -->
  <title>QTextItem Class | Qt GUI 5.14.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.14</a></td><td ><a href="qtgui-index.html">Qt GUI</a></td><td ><a href="qtgui-module.html">C++ Classes</a></td><td >QTextItem</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtgui-index.html">Qt 5.14.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QTextItem Class</h1>
<!-- $$$QTextItem-brief -->
<p>The QTextItem class provides all the information required to draw text in a custom paint engine. <a href="#details">More...</a></p>
<!-- @@@QTextItem -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QTextItem&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += gui</td></tr></table></div><ul>
<li><a href="qtextitem-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qtextitem.html#RenderFlag-enum">RenderFlag</a></b> { RightToLeft, Overline, Underline, StrikeOut }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qtextitem.html#RenderFlag-enum">RenderFlags</a></b></td></tr>
</table></div>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextitem.html#ascent">ascent</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextitem.html#descent">descent</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QFont </td><td class="memItemRight bottomAlign"><b><a href="qtextitem.html#font">font</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextItem::RenderFlags </td><td class="memItemRight bottomAlign"><b><a href="qtextitem.html#renderFlags">renderFlags</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qtextitem.html#text">text</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextitem.html#width">width</a></b>() const</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QTextItem-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>When you reimplement your own paint engine, you must reimplement <a href="qpaintengine.html#drawTextItem">QPaintEngine::drawTextItem</a>(), a function that takes a QTextItem as one of its arguments.</p>
</div>
<!-- @@@QTextItem -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$RenderFlag$$$RightToLeft$$$Overline$$$Underline$$$StrikeOut$$$Dummy -->
<h3 class="flags" id="RenderFlag-enum"><a name="RenderFlag-enum"></a>enum QTextItem::<span class="name">RenderFlag</span><br/>flags QTextItem::<span class="name">RenderFlags</span></h3>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QTextItem::RightToLeft</code></td><td class="topAlign tblval"><code>0x1</code></td><td class="topAlign">Render the text from right to left.</td></tr>
<tr><td class="topAlign"><code>QTextItem::Overline</code></td><td class="topAlign tblval"><code>0x10</code></td><td class="topAlign">Paint a line above the text.</td></tr>
<tr><td class="topAlign"><code>QTextItem::Underline</code></td><td class="topAlign tblval"><code>0x20</code></td><td class="topAlign">Paint a line under the text.</td></tr>
<tr><td class="topAlign"><code>QTextItem::StrikeOut</code></td><td class="topAlign tblval"><code>0x40</code></td><td class="topAlign">Paint a line through the text.</td></tr>
</table></div>
<p>The RenderFlags type is a typedef for <a href="../qtcore/qflags.html">QFlags</a>&lt;RenderFlag&gt;. It stores an OR combination of RenderFlag values.</p>
<!-- @@@RenderFlag -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$ascent[overload1]$$$ascent -->
<h3 class="fn" id="ascent"><a name="ascent"></a><span class="type"><a href="../qtcore/qtglobal.html#qreal-typedef">qreal</a></span> QTextItem::<span class="name">ascent</span>() const</h3>
<p>Corresponds to the <a href="qfontmetrics.html#ascent">ascent</a> of the piece of text that is drawn.</p>
<!-- @@@ascent -->
<!-- $$$descent[overload1]$$$descent -->
<h3 class="fn" id="descent"><a name="descent"></a><span class="type"><a href="../qtcore/qtglobal.html#qreal-typedef">qreal</a></span> QTextItem::<span class="name">descent</span>() const</h3>
<p>Corresponds to the <a href="qfontmetrics.html#descent">descent</a> of the piece of text that is drawn.</p>
<!-- @@@descent -->
<!-- $$$font[overload1]$$$font -->
<h3 class="fn" id="font"><a name="font"></a><span class="type"><a href="qfont.html">QFont</a></span> QTextItem::<span class="name">font</span>() const</h3>
<p>Returns the font that should be used to draw the text.</p>
<!-- @@@font -->
<!-- $$$renderFlags[overload1]$$$renderFlags -->
<h3 class="fn" id="renderFlags"><a name="renderFlags"></a><span class="type"><a href="qtextitem.html#RenderFlag-enum">QTextItem::RenderFlags</a></span> QTextItem::<span class="name">renderFlags</span>() const</h3>
<p>Returns the render flags used.</p>
<!-- @@@renderFlags -->
<!-- $$$text[overload1]$$$text -->
<h3 class="fn" id="text"><a name="text"></a><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QTextItem::<span class="name">text</span>() const</h3>
<p>Returns the text that should be drawn.</p>
<!-- @@@text -->
<!-- $$$width[overload1]$$$width -->
<h3 class="fn" id="width"><a name="width"></a><span class="type"><a href="../qtcore/qtglobal.html#qreal-typedef">qreal</a></span> QTextItem::<span class="name">width</span>() const</h3>
<p>Specifies the total width of the text to be drawn.</p>
<!-- @@@width -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>
